home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / PRINTER / MSLXV101.ARJ / MSLXV101.DOC < prev    next >
Text File  |  1991-06-24  |  10KB  |  296 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                   MIC Source Lister - Extended 
  9.  
  10.  
  11.                           Version 1.01 
  12.  
  13.  
  14.  
  15.         (c) Copyright 1991 by Maya Integrated Coventures 
  16.                      - All rights reserved. 
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                 Maya Integrated Coventures (MIC) 
  33.  
  34.                      18901 Blue Heron Lane 
  35.                   Gaithersburg, MD 20879-1771 
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53. MSLXV101.DOC                            INTRODUCTION 
  54.  
  55. Purpose of MIC_SLX 
  56.  
  57.      MIC Source Lister - Extended (MIC_SLX) is a utility to print
  58. ASCII text program source files.  It is specifically intended to
  59. provide more user control over the output format than is normally
  60. provided by various source editors.  It also allows printing of
  61. ASCII text files from the command line without having to start an
  62. editor or word processor. 
  63.  
  64.      It has been particularly useful (so far) in helping maintain
  65. current hard copy listings of source code -- the datetime feature
  66. helps to keep track of the most current version.  MIC_SLX listings
  67. also have been used to aid in debugging compilation errors in
  68. non-interactive environments, using the line numbering feature. 
  69. For example, on a recent mainframe project, we used the
  70. communications software (in this case, Procomm Plus) to capture
  71. images of the code from the mainframe editor, and then used MIC_SLX
  72. to print the source.  The source errors, which were referred to by
  73. "card" numbers, could then be readily located.
  74.  
  75.      MIC intends future releases to contain further features to aid
  76. programmers in their various tasks.  Some of the presently planned
  77. enhancements are described later in this document. 
  78.  
  79.  
  80. A Note on Source Languages 
  81.  
  82.      MIC_SLX is specifically designed to produce useful output of
  83. a program source text to the screen or to a printer.  As such, it
  84. attempts a primitive parsing of the source text if a line of source
  85. exceeds the width of the specified output device -- this is
  86. intended to make a line split at an intelligent point, thereby
  87. improving readability. 
  88.  
  89.  
  90. Limitations 
  91.  
  92.      At the present time, MIC_SLX does not attempt to determine the
  93. type of file a user is attempting to print.  Therefore, you may get
  94. some very bizarre results if you try to print, for example, an .EXE
  95. file, or other non-text file.  This means that you should save the
  96. source as an ASCII text file if you intend to print it using
  97. MIC_SLX.  For example, if you are using Microsoft QuickBASIC, you
  98. should use the Text Readable by Other Programs option when saving
  99. your source files. 
  100.  
  101.  
  102.                           LEGAL MATTERS
  103.  
  104. A Note on Shareware 
  105.  
  106.      MIC_SLX is distributed as shareware.  As such, it is
  107. distributed through the user community without copy protection and
  108. with right of free evaluation prior to purchase.  You may make
  109. copies and distribute them to other people as long as (1) you do
  110. not charge a fee for this software, (2) you do not alter it or any
  111. of the accompanying files, and (3) you provide a complete copy of
  112. the program and the accompanying files.  A complete list of the
  113. contents for this version is included below under Packing List. 
  114.  
  115.      Although you have received a copy of this software free of
  116. charge, a great deal of effort and money has gone into its
  117. preparation and distribution.  If you should find this program of
  118. use, then you should register your copy with MIC -- this will
  119. enable us to continue to refine and improve this product to better
  120. serve your needs, and the needs of other users as well.  If you use
  121. MIC_SLX regularly, or if you make commercial use of this product,
  122. MIC expects you to register your copy. 
  123.  
  124.  
  125. Registration
  126.  
  127.      MIC Software appreciates your use of this program.  If you
  128. find it is  useful and would like to support its continued
  129. refinement, please send a check or money order for $20.00 (US) to:
  130.  
  131.           Maya Integrated Coventures
  132.           18901 Blue Heron Lane
  133.           Gaithersburg, MD 20879-1771
  134.  
  135. In return, you will receive a copy of the most recent version of
  136. MIC_SLX, along with some related utilities and information about
  137. other MIC products.  Please specify the version (1.01) & whether
  138. you want 5 1/4 or 3 1/2 inch diskettes.
  139.  
  140.      Registration of your copy of MIC Source Lister - Extended also
  141. allows you access to free support: currently available by mail, or
  142. through CompuServe.
  143.  
  144.  
  145. Packing List
  146.  
  147. -    MIC_SLX.EXE  --    The executable program.
  148. -    READ.ME      --    Getting Started.
  149. -    PRINTDOC.BAT --    Batch File to Print Documentation using
  150.                         MIC_SLX.
  151. -    MSLXV101.DOC --    This document.                         USING THE PROGRAM
  152.  
  153. Installation
  154.  
  155.      For version 1.01, the program MIC_SLX.EXE is the only required
  156. file.  You should load it to a convenient directory on your working
  157. disk.  This program may be renamed for convenience of your use with
  158. no unpleasant side effects -- however, the renamed version should
  159. not be distributed to another user (see LEGAL MATTERS).
  160.  
  161.  
  162. Command Line Format
  163.  
  164.      The syntax of the command line is:
  165.  
  166.           mic_slx [filename] [options] 
  167.  
  168.      Where: 
  169.  
  170.      [filename]     is optional, the program will prompt if not
  171.                     entered. The filename should contain the full
  172.                     path if not in the current default directory. 
  173.  
  174.      [options]  available are as follows: 
  175.  
  176.                /h   =    display this help screen -- overrides all
  177.                          other options 
  178.  
  179.  
  180.                /nol =    no line numbers or level numbers displayed
  181.  
  182.                Default is to print sequential line numbers and a
  183.                level number of 0 for each physical line of the
  184.                source, successive output lines split from the same
  185.                original source line are indicated with a
  186.                sequence/level of "+".  (Note: Level numbers are
  187.                reserved for use when the parsing routines are
  188.                enhanced in future releases.)
  189.  
  190.  
  191.                /p   =    print file listing on PRN, default device
  192.                          is SCRN:. 
  193.  
  194.  
  195.                /lc  =    use C Language delimiters, default is
  196.                          BASIC 
  197.  
  198.                Affects the choice of tokens used as the point at
  199.                which to split a line that exceeds the output width. 
  200.                When a line split must occur because the length of
  201.                the source text exceeds the display/print length
  202.                limit, the program attempts to split the line at a
  203.                convenient delimiter to improve the readability of
  204.                the output.  Version 1.01 recognizes delimiters for
  205.                two languages, BASIC and C.  The default settings
  206.                are for BASIC, the C delimiters are used if the
  207.                program is executed with the /LC option (for
  208.                Language C).  Future versions of MIC_SLX will
  209.                enhance the recognition of language tokens for these
  210.                two languages, as well as recognize additional
  211.                languages -- Ada(R) and PASCAL delimiters are
  212.                scheduled for inclusion in the next major release. 
  213.  
  214.  
  215.                /off =    disable automatic indentation on line
  216.                          split 
  217.  
  218.                Default is to indent successive splits of the line
  219.                at least as far as the first "printable" character
  220.                in the first line.
  221.  
  222.  
  223.                /w [length] =  set maximum line width to [length]
  224.                               characters 
  225.  
  226.                This parameter defines the width of the print image. 
  227.                This value can be reset depending on the number of
  228.                characters you can display on a single line of the
  229.                output device.  For example, if you use compressed
  230.                text on your printer, you can set the value to 132
  231.                to print line printer images.
  232.  
  233.                Default for SCRN: is 80
  234.                Default for PRN is 78
  235.  
  236.                The /w parameter must be large enough to accommodate
  237.                at least 10 characters of the source text.  The
  238.                necessary length can be computed by adding the /m
  239.                parameter plus 20 if the /nol is not present, or 10
  240.                if the /nol option is set.  The default values for
  241.                these parameters depend on whether the /p option is
  242.                set, as follows: 
  243.  
  244.                     with /p, /w78/m10          without /p, /w80/m0.
  245.  
  246.  
  247.                /b [length] =  set maximum number of lines per page
  248.                               to [length] 
  249.  
  250.                Default for SCRN: is 20
  251.                Default for PRN is 55
  252.  
  253.  
  254.                /m [length] =  set left margin to [length]
  255.                               characters 
  256.  
  257.                Default for SCRN: is 0
  258.                Default for PRN is 10                      PAST, PRESENT & FUTURE
  259.  
  260. History
  261.  
  262.      Version 1.01 (June 1991)
  263.  
  264. -         Changed LPT1: to PRN for /P option. 
  265. -         Improved parameter validation. 
  266. -         Added /M (left margin) and /OFF (no auto indent) options
  267. -         Repaired bug in line split when auto indent exceeded line
  268.           width. 
  269. -         Added /W (line width) and /B (page length) options. 
  270.  
  271.      Version 1.00 (April 1991)
  272.  
  273. -         Added help /H and no numbering /NOL options.  Enhanced
  274.           print  controls. 
  275. -         Added scan for newpage character. 
  276. -         Expanded setting of defaults -- added /LC & /P options.
  277. -         Improved file datetime handling. 
  278.  
  279.      Version Alpha
  280.  
  281. -         Added file date and time to 1st page header. 
  282. -         Split of line exceeding linewidth, and partial handling
  283.           of tabs.
  284. -         Stripping of filename from COMMAND$ & expanded print
  285.           controls, printing to screen only. 
  286.  
  287.  
  288. Planned Enhancements for Future Releases: 
  289.  
  290. -    Additional language recognition, e.g., Ada(R) and PASCAL. 
  291. -    Multiple file print (DOS wildcard support). 
  292. -    "Batch" files for parameter and file input. 
  293. -    Translation of "special" characters.
  294. -    Selective printing of text.
  295. 
  296.